Back to Main Menu

URL Protocol Handler

Introduction

Starting from myData version 1.3, myData added support for using a URL protocol that can be used by system administrators and power users to automate myData.

 

This same protocol handler can also be used by third party applications to "talk to" myData.

 

One example is would when a web-based GIS product performs reverse linking to the myData application.

Example

Power users may use the following command under Windows Command Prompt to launch myData and then go to asset record.

 

BD0021 in Buildings asset category.

 

start "" "mydata:action=goto&assetCategory=Buildings&assetID=BD0021"

Specification

During installation of the myData application, the installer registers myData as the URL protocol handler for any URL string that has "mydata" schema.

 

When the Windows operating system encounters these URL that matches "mydata" schema, the query string part of URL is passed to the myData application.

 

Every myData URL must specify the action followed by one or more parameters supported by that action.

 

Every action parameter separated by the & symbol.

 

mydata:action=goto&assetCategory=Buildings&assetID=BD0021&configFile=ProductionConfig

 

In above example, the action is "goto", and there are two parameters, "assetCategory" and "assetID" with parameter values "Buildings" and "BD0021" respectively.

 

The third option preselects the myData config name.

 

Both the action and parameter names are case sensitive.

 

If an unsupported action is used in the URL, the myData application will silently ignore the URL.

 

Any extra unrecognized parameters are also ignored.

Supported Action